Improve reliability of VT responses #17786
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
microsoft-github-policy-service
bot
added
Issue-Bug
lhecker
commented
Aug 23, 2024
Comment on lines
-448
to
-451
| void ControlCore::SendInput(const std::wstring_view wstr) | ||
| { | ||
| _sendInputToConnection(wstr); | ||
| } |
There was a problem hiding this comment.
SendInput now does what _sendInputToConnection previously did.
_sendInputToConnection is now a write-directly-to-connection function.
Comment on lines
+2170
to
+2174
| if (!_pendingResponses.empty()) | ||
| { | ||
| _sendInputToConnection(_pendingResponses); | ||
| _pendingResponses.clear(); | ||
| } |
There was a problem hiding this comment.
This fixes the bug. It also fixes 2nd bug: We'd previously use the old _sendInputToConnection for responses but this would check whether we're read-only. We shouldn't do that for VT responses.
There was a problem hiding this comment.
oh this is clever. it replies with it immediately after the write that caused a reply?
There was a problem hiding this comment.
Yeah exactly. This is much better than before, because it's now processing an entire VT string atomically without unlocking in between. Not sure why I haven't done this from the get-go.
DHowett
approved these changes
Aug 23, 2024
DHowett
pushed a commit
that referenced
this pull request
Aug 23, 2024
* Repurposes `_sendInputToConnection` to send output to the connection no matter whether the terminal is read-only or not. Now `SendInput` is the function responsible for the UI handling. * Buffers responses in a VT string into a single string before sending it as a response all at once. This reduces the chances for the UI thread to insert cursor positions and similar into the input pipe, because we're not constantly unlocking the terminal lock anymore for every response. The only way now that unrelated inputs are inserted into the input pipe is because the VT requests (e.g. DA1, DSR, etc.) are broken up across >1 reads. This also fixes VT responses in read-only panes. Closes #17775 * Repeatedly run `echo ^[[c` in cmd. DA1 responses don't stack & always stay the same ✅ * Run nvim in WSL. Doesn't deadlock when pasting 1MB. ✅ * Run the repro from #17775, which requests a ton of OSC 4 (color palette) responses. Jiggle the cursor on top of the window. Responses never get split up. ✅ (cherry picked from commit b07589e) Service-Card-Id: PVTI_lADOAF3p4s4AmhmszgSK_Dw Service-Version: 1.21
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
_sendInputToConnectionto send output to the connectionno matter whether the terminal is read-only or not.
Now
SendInputis the function responsible for the UI handling.before sending it as a response all at once.
This reduces the chances for the UI thread to insert cursor positions
and similar into the input pipe, because we're not constantly unlocking
the terminal lock anymore for every response. The only way now that
unrelated inputs are inserted into the input pipe is because the VT
requests (e.g. DA1, DSR, etc.) are broken up across >1 reads.
This also fixes VT responses in read-only panes.
Closes #17775
Validation Steps Performed
echo ^[[cin cmd.DA1 responses don't stack & always stay the same ✅
(color palette) responses. Jiggle the cursor on top of the window.
Responses never get split up. ✅